<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.sensor.ant.task;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.io.File;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.util.ArrayList;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.util.Date;<a name="line.5"></a>
<FONT color="green">006</FONT>    import java.util.List;<a name="line.6"></a>
<FONT color="green">007</FONT>    import java.util.Properties;<a name="line.7"></a>
<FONT color="green">008</FONT>    <a name="line.8"></a>
<FONT color="green">009</FONT>    import org.apache.tools.ant.BuildException;<a name="line.9"></a>
<FONT color="green">010</FONT>    import org.apache.tools.ant.DirectoryScanner;<a name="line.10"></a>
<FONT color="green">011</FONT>    import org.apache.tools.ant.Project;<a name="line.11"></a>
<FONT color="green">012</FONT>    import org.apache.tools.ant.Task;<a name="line.12"></a>
<FONT color="green">013</FONT>    import org.apache.tools.ant.types.FileSet;<a name="line.13"></a>
<FONT color="green">014</FONT>    import org.hackystat.sensorshell.SensorShell;<a name="line.14"></a>
<FONT color="green">015</FONT>    import org.hackystat.sensorshell.SensorShellException;<a name="line.15"></a>
<FONT color="green">016</FONT>    import org.hackystat.sensorshell.SensorShellProperties;<a name="line.16"></a>
<FONT color="green">017</FONT>    import org.hackystat.sensorshell.usermap.SensorShellMap;<a name="line.17"></a>
<FONT color="green">018</FONT>    import org.hackystat.sensorshell.usermap.SensorShellMapException;<a name="line.18"></a>
<FONT color="green">019</FONT>    import org.hackystat.utilities.stacktrace.StackTrace;<a name="line.19"></a>
<FONT color="green">020</FONT>    import org.hackystat.utilities.tstamp.TstampSet;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    /**<a name="line.22"></a>
<FONT color="green">023</FONT>     * An abstract superclass containing instance variables and helper methods used by Hackystat Sensors<a name="line.23"></a>
<FONT color="green">024</FONT>     * implemented as Ant tasks. This includes almost all of the sensors except for the Ant Build<a name="line.24"></a>
<FONT color="green">025</FONT>     * sensor, which is implemented as a listener.<a name="line.25"></a>
<FONT color="green">026</FONT>     * <a name="line.26"></a>
<FONT color="green">027</FONT>     * @author Philip Johnson<a name="line.27"></a>
<FONT color="green">028</FONT>     */<a name="line.28"></a>
<FONT color="green">029</FONT>    public abstract class HackystatSensorTask extends Task {<a name="line.29"></a>
<FONT color="green">030</FONT>    <a name="line.30"></a>
<FONT color="green">031</FONT>      /** The list of datafile element instances found in the task. */<a name="line.31"></a>
<FONT color="green">032</FONT>      protected List&lt;DataFiles&gt; dataFilesList = new ArrayList&lt;DataFiles&gt;();<a name="line.32"></a>
<FONT color="green">033</FONT>    <a name="line.33"></a>
<FONT color="green">034</FONT>      /** The list of sourcefile element instances found in this task. */<a name="line.34"></a>
<FONT color="green">035</FONT>      protected List&lt;SourceFiles&gt; sourceFilesList = new ArrayList&lt;SourceFiles&gt;();<a name="line.35"></a>
<FONT color="green">036</FONT>    <a name="line.36"></a>
<FONT color="green">037</FONT>      /** Whether or not to print out additional messages during sensor execution. */<a name="line.37"></a>
<FONT color="green">038</FONT>      protected boolean verbose = false;<a name="line.38"></a>
<FONT color="green">039</FONT>    <a name="line.39"></a>
<FONT color="green">040</FONT>      /** Whether or not to throw a BuildException if problems occur during sensor execution. */<a name="line.40"></a>
<FONT color="green">041</FONT>      protected boolean failOnError = true;<a name="line.41"></a>
<FONT color="green">042</FONT>    <a name="line.42"></a>
<FONT color="green">043</FONT>      /** Provides a fixed runtime value for use in sensors that need one. */<a name="line.43"></a>
<FONT color="green">044</FONT>      protected long runtime = new Date().getTime();<a name="line.44"></a>
<FONT color="green">045</FONT>    <a name="line.45"></a>
<FONT color="green">046</FONT>      /** The sensor shell instance used by this sensor. */<a name="line.46"></a>
<FONT color="green">047</FONT>      protected SensorShell sensorShell;<a name="line.47"></a>
<FONT color="green">048</FONT>    <a name="line.48"></a>
<FONT color="green">049</FONT>      /** Sensor properties to be used with the sensor. */<a name="line.49"></a>
<FONT color="green">050</FONT>      protected SensorShellProperties sensorProps;<a name="line.50"></a>
<FONT color="green">051</FONT>    <a name="line.51"></a>
<FONT color="green">052</FONT>      /** Supports generation of unique timestamps. */<a name="line.52"></a>
<FONT color="green">053</FONT>      protected TstampSet tstampSet = new TstampSet();<a name="line.53"></a>
<FONT color="green">054</FONT>    <a name="line.54"></a>
<FONT color="green">055</FONT>      /** The name of this tool, passed to SensorShell and also looked for in UserMap. */<a name="line.55"></a>
<FONT color="green">056</FONT>      protected String tool;<a name="line.56"></a>
<FONT color="green">057</FONT>    <a name="line.57"></a>
<FONT color="green">058</FONT>      /** Tool account in the UserMap to use, or null if not using UserMap. */<a name="line.58"></a>
<FONT color="green">059</FONT>      protected String toolAccount;<a name="line.59"></a>
<FONT color="green">060</FONT>    <a name="line.60"></a>
<FONT color="green">061</FONT>      /** The string that prefixes all error messages from this sensor. */<a name="line.61"></a>
<FONT color="green">062</FONT>      protected String errMsgPrefix;<a name="line.62"></a>
<FONT color="green">063</FONT>    <a name="line.63"></a>
<FONT color="green">064</FONT>      /** The string that prefixes all normal messages from this sensor. */<a name="line.64"></a>
<FONT color="green">065</FONT>      protected String msgPrefix;<a name="line.65"></a>
<FONT color="green">066</FONT>    <a name="line.66"></a>
<FONT color="green">067</FONT>      /** Prevent no-arg constructor from being instantiated externally by accident. */<a name="line.67"></a>
<FONT color="green">068</FONT>      @SuppressWarnings("unused")<a name="line.68"></a>
<FONT color="green">069</FONT>      private HackystatSensorTask() {<a name="line.69"></a>
<FONT color="green">070</FONT>      }<a name="line.70"></a>
<FONT color="green">071</FONT>    <a name="line.71"></a>
<FONT color="green">072</FONT>      /** The number of times you can retry this sensor before failing. */<a name="line.72"></a>
<FONT color="green">073</FONT>      private int retryAttempts = 0;<a name="line.73"></a>
<FONT color="green">074</FONT>    <a name="line.74"></a>
<FONT color="green">075</FONT>      /** The amount of time to wait between retries. */<a name="line.75"></a>
<FONT color="green">076</FONT>      private int retryWaitInterval = 1;<a name="line.76"></a>
<FONT color="green">077</FONT>    <a name="line.77"></a>
<FONT color="green">078</FONT>      /**<a name="line.78"></a>
<FONT color="green">079</FONT>       * The standard constructor, which will instantiate a SensorShell using the configuration data in<a name="line.79"></a>
<FONT color="green">080</FONT>       * sensorshell.properties.<a name="line.80"></a>
<FONT color="green">081</FONT>       * <a name="line.81"></a>
<FONT color="green">082</FONT>       * @param tool The tool associated with this sensor.<a name="line.82"></a>
<FONT color="green">083</FONT>       */<a name="line.83"></a>
<FONT color="green">084</FONT>      protected HackystatSensorTask(String tool) {<a name="line.84"></a>
<FONT color="green">085</FONT>        this.tool = tool;<a name="line.85"></a>
<FONT color="green">086</FONT>        this.msgPrefix = "[Hackystat " + tool + " Sensor] ";<a name="line.86"></a>
<FONT color="green">087</FONT>        this.errMsgPrefix = msgPrefix + "ERROR: ";<a name="line.87"></a>
<FONT color="green">088</FONT>      }<a name="line.88"></a>
<FONT color="green">089</FONT>    <a name="line.89"></a>
<FONT color="green">090</FONT>      /**<a name="line.90"></a>
<FONT color="green">091</FONT>       * A special constructor to be used only for testing purposes, which will use the supplied<a name="line.91"></a>
<FONT color="green">092</FONT>       * SensorBase host, email, and password. Automatically sets verbose mode to true.<a name="line.92"></a>
<FONT color="green">093</FONT>       * <a name="line.93"></a>
<FONT color="green">094</FONT>       * @param host The host.<a name="line.94"></a>
<FONT color="green">095</FONT>       * @param email The email.<a name="line.95"></a>
<FONT color="green">096</FONT>       * @param password The password.<a name="line.96"></a>
<FONT color="green">097</FONT>       * @param tool The tool associated with this sensor.<a name="line.97"></a>
<FONT color="green">098</FONT>       */<a name="line.98"></a>
<FONT color="green">099</FONT>      protected HackystatSensorTask(String host, String email, String password, String tool) {<a name="line.99"></a>
<FONT color="green">100</FONT>        this(tool);<a name="line.100"></a>
<FONT color="green">101</FONT>        this.verbose = true;<a name="line.101"></a>
<FONT color="green">102</FONT>        verboseInfo("Creating a test sensorshell...");<a name="line.102"></a>
<FONT color="green">103</FONT>        try {<a name="line.103"></a>
<FONT color="green">104</FONT>          this.sensorProps = SensorShellProperties.getTestInstance(host, email, password);<a name="line.104"></a>
<FONT color="green">105</FONT>        }<a name="line.105"></a>
<FONT color="green">106</FONT>        catch (SensorShellException e) {<a name="line.106"></a>
<FONT color="green">107</FONT>          throw new BuildException(errMsgPrefix + "Problem making test sensorshell.properties", e);<a name="line.107"></a>
<FONT color="green">108</FONT>        }<a name="line.108"></a>
<FONT color="green">109</FONT>        this.sensorShell = new SensorShell(this.sensorProps, false, tool);<a name="line.109"></a>
<FONT color="green">110</FONT>      }<a name="line.110"></a>
<FONT color="green">111</FONT>    <a name="line.111"></a>
<FONT color="green">112</FONT>      /**<a name="line.112"></a>
<FONT color="green">113</FONT>       * Instantiates the internal sensorshell using either the data in the UserMap or the data in<a name="line.113"></a>
<FONT color="green">114</FONT>       * sensorshell.properties. Does not instantiate the sensorshell if it already has been done in the<a name="line.114"></a>
<FONT color="green">115</FONT>       * testing constructor.<a name="line.115"></a>
<FONT color="green">116</FONT>       * <a name="line.116"></a>
<FONT color="green">117</FONT>       * DO NOT call this method in your constructor. Instead, call it at the beginning of your<a name="line.117"></a>
<FONT color="green">118</FONT>       * execute() method. The reason is that the toolAccount property which controls where the<a name="line.118"></a>
<FONT color="green">119</FONT>       * SensorShell data is obtained is not set until Ant finishes constructor setup.<a name="line.119"></a>
<FONT color="green">120</FONT>       */<a name="line.120"></a>
<FONT color="green">121</FONT>      protected void setupSensorShell() {<a name="line.121"></a>
<FONT color="green">122</FONT>        Properties preferMultiShell = new Properties();<a name="line.122"></a>
<FONT color="green">123</FONT>        // Enabling multishell adds almost 5 seconds of startup time. Therefore, I'm not going to<a name="line.123"></a>
<FONT color="green">124</FONT>        // enable it by default. I'm leaving this in here as commented out code in case someone<a name="line.124"></a>
<FONT color="green">125</FONT>        // in future wants to see how to create a custom default for all Ant sensors that can still<a name="line.125"></a>
<FONT color="green">126</FONT>        // be overridden in the user's sensorshell.properties file.<a name="line.126"></a>
<FONT color="green">127</FONT>        // For now, I just pass in an empty properties instance, which does nothing.<a name="line.127"></a>
<FONT color="green">128</FONT>        // preferMultiShell.setProperty(SensorShellProperties.SENSORSHELL_MULTISHELL_ENABLED_KEY,<a name="line.128"></a>
<FONT color="green">129</FONT>        // "true");<a name="line.129"></a>
<FONT color="green">130</FONT>    <a name="line.130"></a>
<FONT color="green">131</FONT>        if (isUsingUserMap()) {<a name="line.131"></a>
<FONT color="green">132</FONT>          verboseInfo("Creating a SensorShell based upon UserMap data...");<a name="line.132"></a>
<FONT color="green">133</FONT>          try {<a name="line.133"></a>
<FONT color="green">134</FONT>            SensorShellMap map = new SensorShellMap(this.tool);<a name="line.134"></a>
<FONT color="green">135</FONT>            this.sensorShell = map.getUserShell(this.toolAccount, preferMultiShell);<a name="line.135"></a>
<FONT color="green">136</FONT>            this.sensorProps = this.sensorShell.getProperties();<a name="line.136"></a>
<FONT color="green">137</FONT>          }<a name="line.137"></a>
<FONT color="green">138</FONT>          catch (SensorShellMapException e) {<a name="line.138"></a>
<FONT color="green">139</FONT>            signalError("Problem creating a UserMap-based SensorShell", e);<a name="line.139"></a>
<FONT color="green">140</FONT>          }<a name="line.140"></a>
<FONT color="green">141</FONT>        }<a name="line.141"></a>
<FONT color="green">142</FONT>        // Instantiate the sensorshell using sensorshell.properties, unless we've already created one<a name="line.142"></a>
<FONT color="green">143</FONT>        // using the test constructor.<a name="line.143"></a>
<FONT color="green">144</FONT>        else if (this.sensorProps == null &amp;&amp; this.sensorShell == null) {<a name="line.144"></a>
<FONT color="green">145</FONT>          verboseInfo("Creating a SensorShell using sensorshell.properties data...");<a name="line.145"></a>
<FONT color="green">146</FONT>          // use the sensor.properties file<a name="line.146"></a>
<FONT color="green">147</FONT>          try {<a name="line.147"></a>
<FONT color="green">148</FONT>            this.sensorProps = new SensorShellProperties(preferMultiShell, false);<a name="line.148"></a>
<FONT color="green">149</FONT>            this.sensorShell = new SensorShell(this.sensorProps, false, this.tool);<a name="line.149"></a>
<FONT color="green">150</FONT>          }<a name="line.150"></a>
<FONT color="green">151</FONT>          catch (SensorShellException e) {<a name="line.151"></a>
<FONT color="green">152</FONT>            signalError("Problem creating the SensorShell", e);<a name="line.152"></a>
<FONT color="green">153</FONT>          }<a name="line.153"></a>
<FONT color="green">154</FONT>        }<a name="line.154"></a>
<FONT color="green">155</FONT>        verboseInfo(this.sensorShell.getProperties().toString());<a name="line.155"></a>
<FONT color="green">156</FONT>        verboseInfo("Maximum Java heap size is: " + Runtime.getRuntime().maxMemory());<a name="line.156"></a>
<FONT color="green">157</FONT>        <a name="line.157"></a>
<FONT color="green">158</FONT>      }<a name="line.158"></a>
<FONT color="green">159</FONT>    <a name="line.159"></a>
<FONT color="green">160</FONT>      /**<a name="line.160"></a>
<FONT color="green">161</FONT>       * Set the verbose attribute to "on", "true", or "yes" to enable trace messages while the sensor<a name="line.161"></a>
<FONT color="green">162</FONT>       * is running. Default is false.<a name="line.162"></a>
<FONT color="green">163</FONT>       * <a name="line.163"></a>
<FONT color="green">164</FONT>       * @param mode The new verbose value: should be "on", "true", or "yes" to enable.<a name="line.164"></a>
<FONT color="green">165</FONT>       */<a name="line.165"></a>
<FONT color="green">166</FONT>      public void setVerbose(String mode) {<a name="line.166"></a>
<FONT color="green">167</FONT>        this.verbose = Project.toBoolean(mode);<a name="line.167"></a>
<FONT color="green">168</FONT>        verboseInfo("verbose is set to: " + this.verbose);<a name="line.168"></a>
<FONT color="green">169</FONT>      }<a name="line.169"></a>
<FONT color="green">170</FONT>    <a name="line.170"></a>
<FONT color="green">171</FONT>      /**<a name="line.171"></a>
<FONT color="green">172</FONT>       * Set the retryWaitIntervalSeconds value to an integer, or set to default if the supplied value<a name="line.172"></a>
<FONT color="green">173</FONT>       * was not an integer.<a name="line.173"></a>
<FONT color="green">174</FONT>       * <a name="line.174"></a>
<FONT color="green">175</FONT>       * @param retryString The new retryWaitIntervalSeconds value, an integer, as a string.<a name="line.175"></a>
<FONT color="green">176</FONT>       */<a name="line.176"></a>
<FONT color="green">177</FONT>      public void setRetryWaitInterval(String retryString) {<a name="line.177"></a>
<FONT color="green">178</FONT>        int retry = 0;<a name="line.178"></a>
<FONT color="green">179</FONT>        try {<a name="line.179"></a>
<FONT color="green">180</FONT>          retry = Integer.parseInt(retryString);<a name="line.180"></a>
<FONT color="green">181</FONT>        }<a name="line.181"></a>
<FONT color="green">182</FONT>        catch (Exception e) {<a name="line.182"></a>
<FONT color="green">183</FONT>          info("Failed to parse attribute retryAttempts. Setting to default.");<a name="line.183"></a>
<FONT color="green">184</FONT>        }<a name="line.184"></a>
<FONT color="green">185</FONT>        this.retryWaitInterval = retry;<a name="line.185"></a>
<FONT color="green">186</FONT>        verboseInfo("retryWaitInterval is set to: " + this.retryWaitInterval);<a name="line.186"></a>
<FONT color="green">187</FONT>      }<a name="line.187"></a>
<FONT color="green">188</FONT>    <a name="line.188"></a>
<FONT color="green">189</FONT>      /**<a name="line.189"></a>
<FONT color="green">190</FONT>       * Set the retryAttempts value to an integer, or set to default if the supplied value was not an<a name="line.190"></a>
<FONT color="green">191</FONT>       * integer.<a name="line.191"></a>
<FONT color="green">192</FONT>       * <a name="line.192"></a>
<FONT color="green">193</FONT>       * @param retryString The new retryAttempts value, an integer, as a string.<a name="line.193"></a>
<FONT color="green">194</FONT>       */<a name="line.194"></a>
<FONT color="green">195</FONT>      public void setRetryAttempts(String retryString) {<a name="line.195"></a>
<FONT color="green">196</FONT>        int retry = 0;<a name="line.196"></a>
<FONT color="green">197</FONT>        try {<a name="line.197"></a>
<FONT color="green">198</FONT>          retry = Integer.parseInt(retryString);<a name="line.198"></a>
<FONT color="green">199</FONT>        }<a name="line.199"></a>
<FONT color="green">200</FONT>        catch (Exception e) {<a name="line.200"></a>
<FONT color="green">201</FONT>          info("Failed to parse attribute retryAttempts. Setting to default.");<a name="line.201"></a>
<FONT color="green">202</FONT>        }<a name="line.202"></a>
<FONT color="green">203</FONT>        this.retryAttempts = retry;<a name="line.203"></a>
<FONT color="green">204</FONT>        verboseInfo("retryAttempts is set to: " + this.retryAttempts);<a name="line.204"></a>
<FONT color="green">205</FONT>      }<a name="line.205"></a>
<FONT color="green">206</FONT>    <a name="line.206"></a>
<FONT color="green">207</FONT>      /**<a name="line.207"></a>
<FONT color="green">208</FONT>       * The execute() method invoked by Ant. This method invokes the subclass executeInternal() method,<a name="line.208"></a>
<FONT color="green">209</FONT>       * and if that method throws an exception, it will retry according to the values of retryAttempts<a name="line.209"></a>
<FONT color="green">210</FONT>       * and retryWaitInterval.<a name="line.210"></a>
<FONT color="green">211</FONT>       * <a name="line.211"></a>
<FONT color="green">212</FONT>       * @throws BuildException If there is an error after all the retries are done.<a name="line.212"></a>
<FONT color="green">213</FONT>       */<a name="line.213"></a>
<FONT color="green">214</FONT>      @Override<a name="line.214"></a>
<FONT color="green">215</FONT>      public void execute() throws BuildException {<a name="line.215"></a>
<FONT color="green">216</FONT>        for (int i = retryAttempts; i &gt;= 0; i--) {<a name="line.216"></a>
<FONT color="green">217</FONT>          try {<a name="line.217"></a>
<FONT color="green">218</FONT>            executeInternal();<a name="line.218"></a>
<FONT color="green">219</FONT>            return;<a name="line.219"></a>
<FONT color="green">220</FONT>          }<a name="line.220"></a>
<FONT color="green">221</FONT>          catch (Exception e) {<a name="line.221"></a>
<FONT color="green">222</FONT>            // If we're all out of retries (or never had any), then just rethrow this exception.<a name="line.222"></a>
<FONT color="green">223</FONT>            if (i == 0) {<a name="line.223"></a>
<FONT color="green">224</FONT>              throw new BuildException(e);<a name="line.224"></a>
<FONT color="green">225</FONT>            }<a name="line.225"></a>
<FONT color="green">226</FONT>            // Else, we indicate what happened, sleep, and go through the loop again.<a name="line.226"></a>
<FONT color="green">227</FONT>            info("Sensor failed: " + e.getMessage());<a name="line.227"></a>
<FONT color="green">228</FONT>            info("Retrying (" + i + " retries remaining.)");<a name="line.228"></a>
<FONT color="green">229</FONT>            info("Pausing for: " + this.retryWaitInterval + " seconds.");<a name="line.229"></a>
<FONT color="green">230</FONT>            try {<a name="line.230"></a>
<FONT color="green">231</FONT>              Thread.sleep(this.retryWaitInterval * 1000);<a name="line.231"></a>
<FONT color="green">232</FONT>            }<a name="line.232"></a>
<FONT color="green">233</FONT>            catch (Exception f) {<a name="line.233"></a>
<FONT color="green">234</FONT>              info("Problem trying to sleep. We ignore.");<a name="line.234"></a>
<FONT color="green">235</FONT>            }<a name="line.235"></a>
<FONT color="green">236</FONT>          }<a name="line.236"></a>
<FONT color="green">237</FONT>        }<a name="line.237"></a>
<FONT color="green">238</FONT>      }<a name="line.238"></a>
<FONT color="green">239</FONT>    <a name="line.239"></a>
<FONT color="green">240</FONT>      /**<a name="line.240"></a>
<FONT color="green">241</FONT>       * This must be implemented by all subclasses to provide the traditional Ant execute() method.<a name="line.241"></a>
<FONT color="green">242</FONT>       * The executeInternal may be invoked multiple times, depending upon the retryAttempts value.<a name="line.242"></a>
<FONT color="green">243</FONT>       */<a name="line.243"></a>
<FONT color="green">244</FONT>      public abstract void executeInternal();<a name="line.244"></a>
<FONT color="green">245</FONT>    <a name="line.245"></a>
<FONT color="green">246</FONT>      /**<a name="line.246"></a>
<FONT color="green">247</FONT>       * Set the failOnError attribute to "on", "true", or "yes" to throw a BuildException if problems<a name="line.247"></a>
<FONT color="green">248</FONT>       * occur during execution. Default is true.<a name="line.248"></a>
<FONT color="green">249</FONT>       * <a name="line.249"></a>
<FONT color="green">250</FONT>       * @param mode The new verbose value: should be "on", "true", or "yes" to enable.<a name="line.250"></a>
<FONT color="green">251</FONT>       */<a name="line.251"></a>
<FONT color="green">252</FONT>      public void setFailOnError(String mode) {<a name="line.252"></a>
<FONT color="green">253</FONT>        this.failOnError = Project.toBoolean(mode);<a name="line.253"></a>
<FONT color="green">254</FONT>        verboseInfo("failOnError is set to: " + this.failOnError);<a name="line.254"></a>
<FONT color="green">255</FONT>      }<a name="line.255"></a>
<FONT color="green">256</FONT>    <a name="line.256"></a>
<FONT color="green">257</FONT>      /**<a name="line.257"></a>
<FONT color="green">258</FONT>       * Allows the user to override the default tool string to be used to retrieve data from the<a name="line.258"></a>
<FONT color="green">259</FONT>       * UserMap. Note that UserMap processing is only enabled when the toolAccount value is provided.<a name="line.259"></a>
<FONT color="green">260</FONT>       * <a name="line.260"></a>
<FONT color="green">261</FONT>       * @param tool The tool containing the tool account to be used when sending data.<a name="line.261"></a>
<FONT color="green">262</FONT>       */<a name="line.262"></a>
<FONT color="green">263</FONT>      public void setUserMapTool(String tool) {<a name="line.263"></a>
<FONT color="green">264</FONT>        this.tool = tool;<a name="line.264"></a>
<FONT color="green">265</FONT>      }<a name="line.265"></a>
<FONT color="green">266</FONT>    <a name="line.266"></a>
<FONT color="green">267</FONT>      /**<a name="line.267"></a>
<FONT color="green">268</FONT>       * If the user specifies a toolAccount, then the UserMap is consulted to specify the sensorshell<a name="line.268"></a>
<FONT color="green">269</FONT>       * host, user, and password data rather than sensorshell.properties. Note that the user does not<a name="line.269"></a>
<FONT color="green">270</FONT>       * need to specify the tool explicitly, it will be provided with a default value by the sensor,<a name="line.270"></a>
<FONT color="green">271</FONT>       * although specifying it explicitly might be good for documentation purposes.<a name="line.271"></a>
<FONT color="green">272</FONT>       * <a name="line.272"></a>
<FONT color="green">273</FONT>       * @param toolAccount The tool account in the UserMap to use when sending data.<a name="line.273"></a>
<FONT color="green">274</FONT>       */<a name="line.274"></a>
<FONT color="green">275</FONT>      public void setUserMapToolAccount(String toolAccount) {<a name="line.275"></a>
<FONT color="green">276</FONT>        this.toolAccount = toolAccount;<a name="line.276"></a>
<FONT color="green">277</FONT>      }<a name="line.277"></a>
<FONT color="green">278</FONT>    <a name="line.278"></a>
<FONT color="green">279</FONT>      /**<a name="line.279"></a>
<FONT color="green">280</FONT>       * Creates a returns a new SourceFiles instance to Ant. Ant will then populate this guy with its<a name="line.280"></a>
<FONT color="green">281</FONT>       * internal file set.<a name="line.281"></a>
<FONT color="green">282</FONT>       * <a name="line.282"></a>
<FONT color="green">283</FONT>       * @return The SourceFiles instance.<a name="line.283"></a>
<FONT color="green">284</FONT>       */<a name="line.284"></a>
<FONT color="green">285</FONT>      public SourceFiles createSourceFiles() {<a name="line.285"></a>
<FONT color="green">286</FONT>        SourceFiles newSourceFiles = new SourceFiles();<a name="line.286"></a>
<FONT color="green">287</FONT>        this.sourceFilesList.add(newSourceFiles);<a name="line.287"></a>
<FONT color="green">288</FONT>        return newSourceFiles;<a name="line.288"></a>
<FONT color="green">289</FONT>      }<a name="line.289"></a>
<FONT color="green">290</FONT>    <a name="line.290"></a>
<FONT color="green">291</FONT>      /**<a name="line.291"></a>
<FONT color="green">292</FONT>       * Creates a returns a new DataFiles instance to Ant. Ant will then populate this guy with its<a name="line.292"></a>
<FONT color="green">293</FONT>       * internal file set.<a name="line.293"></a>
<FONT color="green">294</FONT>       * <a name="line.294"></a>
<FONT color="green">295</FONT>       * @return The DataFiles instance.<a name="line.295"></a>
<FONT color="green">296</FONT>       */<a name="line.296"></a>
<FONT color="green">297</FONT>      public DataFiles createDataFiles() {<a name="line.297"></a>
<FONT color="green">298</FONT>        DataFiles newDataFiles = new DataFiles();<a name="line.298"></a>
<FONT color="green">299</FONT>        this.dataFilesList.add(newDataFiles);<a name="line.299"></a>
<FONT color="green">300</FONT>        return newDataFiles;<a name="line.300"></a>
<FONT color="green">301</FONT>      }<a name="line.301"></a>
<FONT color="green">302</FONT>    <a name="line.302"></a>
<FONT color="green">303</FONT>      /**<a name="line.303"></a>
<FONT color="green">304</FONT>       * Returns the list of files indicated in the sourcefiles element.<a name="line.304"></a>
<FONT color="green">305</FONT>       * <a name="line.305"></a>
<FONT color="green">306</FONT>       * @return The list of files in the sourcefiles element.<a name="line.306"></a>
<FONT color="green">307</FONT>       */<a name="line.307"></a>
<FONT color="green">308</FONT>      protected ArrayList&lt;File&gt; getSourceFiles() {<a name="line.308"></a>
<FONT color="green">309</FONT>        List&lt;FileSet&gt; filesets = new ArrayList&lt;FileSet&gt;();<a name="line.309"></a>
<FONT color="green">310</FONT>        // Create our list of filesets from all nested SourceFiles.<a name="line.310"></a>
<FONT color="green">311</FONT>        for (SourceFiles sourceFiles : this.sourceFilesList) {<a name="line.311"></a>
<FONT color="green">312</FONT>          filesets.addAll(sourceFiles.getFileSets());<a name="line.312"></a>
<FONT color="green">313</FONT>        }<a name="line.313"></a>
<FONT color="green">314</FONT>        return getFiles(filesets);<a name="line.314"></a>
<FONT color="green">315</FONT>      }<a name="line.315"></a>
<FONT color="green">316</FONT>    <a name="line.316"></a>
<FONT color="green">317</FONT>      /**<a name="line.317"></a>
<FONT color="green">318</FONT>       * Returns the list of files indicated in the datafiles element.<a name="line.318"></a>
<FONT color="green">319</FONT>       * <a name="line.319"></a>
<FONT color="green">320</FONT>       * @return The list of files in the datafiles element.<a name="line.320"></a>
<FONT color="green">321</FONT>       */<a name="line.321"></a>
<FONT color="green">322</FONT>      protected ArrayList&lt;File&gt; getDataFiles() {<a name="line.322"></a>
<FONT color="green">323</FONT>        List&lt;FileSet&gt; filesets = new ArrayList&lt;FileSet&gt;();<a name="line.323"></a>
<FONT color="green">324</FONT>        // Create our list of filesets from all nested SourceFiles.<a name="line.324"></a>
<FONT color="green">325</FONT>        for (DataFiles dataFiles : this.dataFilesList) {<a name="line.325"></a>
<FONT color="green">326</FONT>          filesets.addAll(dataFiles.getFileSets());<a name="line.326"></a>
<FONT color="green">327</FONT>        }<a name="line.327"></a>
<FONT color="green">328</FONT>        return getFiles(filesets);<a name="line.328"></a>
<FONT color="green">329</FONT>      }<a name="line.329"></a>
<FONT color="green">330</FONT>    <a name="line.330"></a>
<FONT color="green">331</FONT>      /**<a name="line.331"></a>
<FONT color="green">332</FONT>       * Converts a list of FileSets into a list of their associated files.<a name="line.332"></a>
<FONT color="green">333</FONT>       * <a name="line.333"></a>
<FONT color="green">334</FONT>       * @param filesets The filesets of interest.<a name="line.334"></a>
<FONT color="green">335</FONT>       * @return The files of interest.<a name="line.335"></a>
<FONT color="green">336</FONT>       */<a name="line.336"></a>
<FONT color="green">337</FONT>      protected ArrayList&lt;File&gt; getFiles(List&lt;FileSet&gt; filesets) {<a name="line.337"></a>
<FONT color="green">338</FONT>        ArrayList&lt;File&gt; fileList = new ArrayList&lt;File&gt;();<a name="line.338"></a>
<FONT color="green">339</FONT>        final int size = filesets.size();<a name="line.339"></a>
<FONT color="green">340</FONT>        for (int i = 0; i &lt; size; i++) {<a name="line.340"></a>
<FONT color="green">341</FONT>          FileSet fs = filesets.get(i);<a name="line.341"></a>
<FONT color="green">342</FONT>          DirectoryScanner ds = fs.getDirectoryScanner(getProject());<a name="line.342"></a>
<FONT color="green">343</FONT>          ds.scan();<a name="line.343"></a>
<FONT color="green">344</FONT>          String[] f = ds.getIncludedFiles();<a name="line.344"></a>
<FONT color="green">345</FONT>    <a name="line.345"></a>
<FONT color="green">346</FONT>          for (int j = 0; j &lt; f.length; j++) {<a name="line.346"></a>
<FONT color="green">347</FONT>            String pathname = f[j];<a name="line.347"></a>
<FONT color="green">348</FONT>            File file = new File(ds.getBasedir(), pathname);<a name="line.348"></a>
<FONT color="green">349</FONT>            file = getProject().resolveFile(file.getPath());<a name="line.349"></a>
<FONT color="green">350</FONT>            fileList.add(file);<a name="line.350"></a>
<FONT color="green">351</FONT>          }<a name="line.351"></a>
<FONT color="green">352</FONT>        }<a name="line.352"></a>
<FONT color="green">353</FONT>        return fileList;<a name="line.353"></a>
<FONT color="green">354</FONT>      }<a name="line.354"></a>
<FONT color="green">355</FONT>    <a name="line.355"></a>
<FONT color="green">356</FONT>      /**<a name="line.356"></a>
<FONT color="green">357</FONT>       * Returns true if the user has indicated they want to use the UserMap to obtain the SensorBase<a name="line.357"></a>
<FONT color="green">358</FONT>       * host, user, and password. If false, then the sensorshell.properties file should be consulted.<a name="line.358"></a>
<FONT color="green">359</FONT>       * <a name="line.359"></a>
<FONT color="green">360</FONT>       * @return Returns true if UserMap processing is enabled, false otherwise.<a name="line.360"></a>
<FONT color="green">361</FONT>       */<a name="line.361"></a>
<FONT color="green">362</FONT>      protected boolean isUsingUserMap() {<a name="line.362"></a>
<FONT color="green">363</FONT>        return (this.tool != null &amp;&amp; this.toolAccount != null);<a name="line.363"></a>
<FONT color="green">364</FONT>      }<a name="line.364"></a>
<FONT color="green">365</FONT>    <a name="line.365"></a>
<FONT color="green">366</FONT>      /**<a name="line.366"></a>
<FONT color="green">367</FONT>       * Output a verbose message if verbose is enabled.<a name="line.367"></a>
<FONT color="green">368</FONT>       * <a name="line.368"></a>
<FONT color="green">369</FONT>       * @param msg The message to print if verbose mode is enabled.<a name="line.369"></a>
<FONT color="green">370</FONT>       */<a name="line.370"></a>
<FONT color="green">371</FONT>      protected final void verboseInfo(String msg) {<a name="line.371"></a>
<FONT color="green">372</FONT>        if (this.verbose) {<a name="line.372"></a>
<FONT color="green">373</FONT>          System.out.println(msg);<a name="line.373"></a>
<FONT color="green">374</FONT>        }<a name="line.374"></a>
<FONT color="green">375</FONT>      }<a name="line.375"></a>
<FONT color="green">376</FONT>    <a name="line.376"></a>
<FONT color="green">377</FONT>      /**<a name="line.377"></a>
<FONT color="green">378</FONT>       * Output an informational message from sensor.<a name="line.378"></a>
<FONT color="green">379</FONT>       * <a name="line.379"></a>
<FONT color="green">380</FONT>       * @param msg The message.<a name="line.380"></a>
<FONT color="green">381</FONT>       */<a name="line.381"></a>
<FONT color="green">382</FONT>      protected final void info(String msg) {<a name="line.382"></a>
<FONT color="green">383</FONT>        System.out.println(msg);<a name="line.383"></a>
<FONT color="green">384</FONT>      }<a name="line.384"></a>
<FONT color="green">385</FONT>    <a name="line.385"></a>
<FONT color="green">386</FONT>      /**<a name="line.386"></a>
<FONT color="green">387</FONT>       * Logs a final summary message regarding the number of entries sent and the elapsed time.<a name="line.387"></a>
<FONT color="green">388</FONT>       * <a name="line.388"></a>
<FONT color="green">389</FONT>       * @param startTime The start time of the sensor.<a name="line.389"></a>
<FONT color="green">390</FONT>       * @param sdt The type of data sent.<a name="line.390"></a>
<FONT color="green">391</FONT>       * @param numEntries The number of entries sent.<a name="line.391"></a>
<FONT color="green">392</FONT>       */<a name="line.392"></a>
<FONT color="green">393</FONT>      protected void summaryInfo(Date startTime, String sdt, int numEntries) {<a name="line.393"></a>
<FONT color="green">394</FONT>        Date endTime = new Date();<a name="line.394"></a>
<FONT color="green">395</FONT>        long elapsedTime = (endTime.getTime() - startTime.getTime()) / 1000;<a name="line.395"></a>
<FONT color="green">396</FONT>        info(numEntries + " " + sdt + " sensor data instances created.");<a name="line.396"></a>
<FONT color="green">397</FONT>        if (this.sensorShell.hasOfflineData()) {<a name="line.397"></a>
<FONT color="green">398</FONT>          info("Some or all of these instances were saved offline and not sent to the server.");<a name="line.398"></a>
<FONT color="green">399</FONT>        }<a name="line.399"></a>
<FONT color="green">400</FONT>        else {<a name="line.400"></a>
<FONT color="green">401</FONT>          info("These instances were transmitted to: " + this.sensorProps.getSensorBaseHost() + " ("<a name="line.401"></a>
<FONT color="green">402</FONT>              + elapsedTime + " secs.)");<a name="line.402"></a>
<FONT color="green">403</FONT>        }<a name="line.403"></a>
<FONT color="green">404</FONT>      }<a name="line.404"></a>
<FONT color="green">405</FONT>    <a name="line.405"></a>
<FONT color="green">406</FONT>      /**<a name="line.406"></a>
<FONT color="green">407</FONT>       * Sends any accumulated data in the SensorShell to the server and quits the shell.<a name="line.407"></a>
<FONT color="green">408</FONT>       */<a name="line.408"></a>
<FONT color="green">409</FONT>      protected void sendAndQuit() {<a name="line.409"></a>
<FONT color="green">410</FONT>        try {<a name="line.410"></a>
<FONT color="green">411</FONT>          this.sensorShell.quit();<a name="line.411"></a>
<FONT color="green">412</FONT>        }<a name="line.412"></a>
<FONT color="green">413</FONT>        catch (SensorShellException e) {<a name="line.413"></a>
<FONT color="green">414</FONT>          signalError("Problem during quit() of SensorShell", e);<a name="line.414"></a>
<FONT color="green">415</FONT>        }<a name="line.415"></a>
<FONT color="green">416</FONT>      }<a name="line.416"></a>
<FONT color="green">417</FONT>    <a name="line.417"></a>
<FONT color="green">418</FONT>      /**<a name="line.418"></a>
<FONT color="green">419</FONT>       * Signals an error, which means throwing a BuildException if failOnError is true, or just logging<a name="line.419"></a>
<FONT color="green">420</FONT>       * the problem if it's not.<a name="line.420"></a>
<FONT color="green">421</FONT>       * <a name="line.421"></a>
<FONT color="green">422</FONT>       * @param msg The informative error message from the client.<a name="line.422"></a>
<FONT color="green">423</FONT>       * @param e The exception.<a name="line.423"></a>
<FONT color="green">424</FONT>       */<a name="line.424"></a>
<FONT color="green">425</FONT>      protected void signalError(String msg, Exception e) {<a name="line.425"></a>
<FONT color="green">426</FONT>        String paddedMsg = msg + " ";<a name="line.426"></a>
<FONT color="green">427</FONT>        if (this.failOnError) {<a name="line.427"></a>
<FONT color="green">428</FONT>          throw new BuildException(errMsgPrefix + paddedMsg + e.getMessage(), e);<a name="line.428"></a>
<FONT color="green">429</FONT>        }<a name="line.429"></a>
<FONT color="green">430</FONT>        else {<a name="line.430"></a>
<FONT color="green">431</FONT>          System.out.println(errMsgPrefix + paddedMsg + e.getMessage());<a name="line.431"></a>
<FONT color="green">432</FONT>          System.out.println(StackTrace.toString(e));<a name="line.432"></a>
<FONT color="green">433</FONT>          System.out.println("Continuing execution since failOnError is false");<a name="line.433"></a>
<FONT color="green">434</FONT>        }<a name="line.434"></a>
<FONT color="green">435</FONT>      }<a name="line.435"></a>
<FONT color="green">436</FONT>    <a name="line.436"></a>
<FONT color="green">437</FONT>    }<a name="line.437"></a>




























































</PRE>
</BODY>
</HTML>
